Fix order of headings #1465
Merged
Fix order of headings #1465
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fixed Dockershim.md
martyav
requested review from
btat,
LucasSaintarbor and
sunilarjun
as code owners
|
Opening up for review at 31 commits, 191 files. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reminders
See the README for more details on how to work with the Rancher docs.
Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.
If the pull request is dependent on an upcoming release, remember to add a "MERGE ON RELEASE" label and set the proper milestone.
Description
The intent of this PR is to fix some errors and warnings that might come up as we convert the files in this repo to AsciiDoc, in anticipation of the site migration to Antora. After doing a test conversion, the compiler threw 1501 errors and warnings, many of them related to section headings being out of order. A heading is considered out of order if it skips one or more heading levels -- for example, if a H1 heading (title) is followed by a section H3 heading, with no H2 in between. This is very common in certain parts of our docs.
Comments
I also fixed some spacing issues and small typos across versions of the same page.